/*
 * Copyright 2010 Biz-e (info@biz-e.nl)
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package nl.biz_e.gwt.baselib.ui.client.menu;

import java.util.List;

/**
 * TODO: Write type comment
 * @author Joost A. Bloemsma
 *
 */
public interface IMenuPanel {
	
	/**
	 * Adds a list of {@link IMenuItem} implementations
	 * 
	 * @param items
	 */
	public abstract void addMenuItems(List<IMenuItem> items);
	
	/**
	 * Adds an {@link IMenuItem} implementation
	 * 
	 * @param menuItem
	 */
	public abstract void addMenuItem(IMenuItem menuItem);
	
	/**
	 * removes a list of {@link IMenuItem} implementations
	 * 
	 * @param items
	 */
	public abstract void removeMenuItems(List<IMenuItem> items);
	
	/**
	 * Removes an {@link IMenuItem} implementation
	 * 
	 * @param menuItem
	 */
	public abstract void removeMenuItem(IMenuItem menuItem);
	
	/**
	 * Rebuilds the menu
	 */
	public abstract void rebuildMenu();
	
	/**
	 * Sets a specific menuitem to the selected state.<br/>
	 * Is called from {@link MenuItem#setSelected(boolean)}
	 * 
	 * @param item
	 * @param selected
	 */
	public abstract void setMenuItemSelected(IMenuItem item, boolean selected);
	
	/**
	 * Sets all menuitems to unselected, except for the passed item.
	 * Is called from
	 * {@link MenuPanelManager#setOnlySelectedMenuItem(IMenuItem)}
	 * 
	 * @param item
	 */
	public abstract void setOnlySelectedMenuItem(IMenuItem item);
	
}